[Emacs-diffs] Changes to newsticker.texi

[Glenn Morris]

CVSROOT:        /sources/emacs
Module name:    emacs
Changes by:     Glenn Morris <gm>       07/09/06 05:01:20

Index: newsticker.texi
===================================================================
RCS file: newsticker.texi
diff -N newsticker.texi
--- /dev/null   1 Jan 1970 00:00:00 -0000
+++ newsticker.texi     6 Sep 2007 05:01:20 -0000       1.1
@@ -0,0 +1,290 @@
+\input texinfo   @c -*-texinfo-*-
address@hidden %**start of header
address@hidden ../info/newsticker
address@hidden VERSION 1.9
address@hidden UPDATED November 2005
address@hidden Newsticker @value{VERSION}
address@hidden vr cp
address@hidden fn cp
address@hidden pg cp
address@hidden %**end of header
+
address@hidden
+This manual is for Newsticker (version @value{VERSION}, @value{UPDATED}).
+
address@hidden
+Copyright @copyright{} 2004, 2005, 2006, 2007  Free Software Foundation, Inc.
+
address@hidden
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 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''
+in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software.  Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License.  If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
address@hidden quotation
address@hidden copying
+
address@hidden Emacs
address@hidden
+* Newsticker: (newsticker). A Newsticker for Emacs.
address@hidden direntry
+
address@hidden
address@hidden Newsticker -- a Newsticker for Emacs
address@hidden for version @value{VERSION}, @value{UPDATED}
address@hidden Ulf Jasper
address@hidden @email{ulf.jasper@@web.de}
address@hidden @uref{http://de.geocities.com/ulf_jasper}
address@hidden
address@hidden 0pt plus 1filll
address@hidden
address@hidden titlepage
+
address@hidden
+
address@hidden
address@hidden Top
address@hidden Newsticker
address@hidden ifnottex
+
address@hidden
+* Overview::        General description of newsticker.
+* Requirements::    Requirements for using newsticker.
+* Installation::    Installing newsticker on your system.
+* Usage::           Basic newsticker instructions.
+* Configuration::   Customizable newsticker settings.
+* Remarks::         Remarks about newsticker.
+* GNU Free Documentation License:: The license for this documentation.
+* Index::           Variable, function, and concept index.
address@hidden menu
+
address@hidden Overview
address@hidden 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
+should work with the following RSS formats:
+
address@hidden
address@hidden RSS 0.91 (see @uref{http://backend.userland.com/rss091} or
address@hidden://my.netscape.com/publish/formats/rss-spec-0.91.html}),
address@hidden RSS 0.92 (see @uref{http://backend.userland.com/rss092}),
address@hidden RSS 1.0 (see @uref{http://purl.org/rss/1.0/spec}
address@hidden RSS 2.0 (see @uref{http://blogs.law.harvard.edu/tech/rss}),
address@hidden itemize
address@hidden
+as well as the following Atom formats:
address@hidden Atom 0.3
address@hidden Atom 1.0 (see
address@hidden://www.ietf.org/internet-drafts/draft-ietf-atompub-format-11.txt}).
address@hidden itemize
+
+That makes Newsticker.el an "Atom aggregator, "RSS reader", or "RSS
+aggregator".
+
+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.).
+
address@hidden
+Here are screen shots of the @uref{newsticker-1.7.png, version 1.7
+(current version)} and some older screen shots:
address@hidden, version 1.6},
address@hidden, version 1.5}, 
address@hidden, version 1.4}
address@hidden, version 1.3}, 
address@hidden, version 1.0}.
address@hidden ifhtml
+
address@hidden Requirements
address@hidden Requirements
+
+Newsticker can be used with
address@hidden://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
+you are using XEmacs you want to get the @file{net-utils} package
+which contains @file{xml.el} for XEmacs.
+
+Newsticker requires a program which can retrieve files via http and
+prints them to stdout.  By default Newsticker will use
address@hidden://www.gnu.org/software/wget/wget.html, wget} for this task.
+
+
address@hidden Installation
address@hidden 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
+(@file{~/.emacs}).
+
address@hidden
+(add-hook 'newsticker-mode-hook 'imenu-add-menubar-index)
address@hidden lisp
+
+That's it.
+
address@hidden Usage
address@hidden Usage
+
address@hidden newsticker-show-news
+The command @code{newsticker-show-news} will display all available
+headlines in a special buffer, called @samp{*newsticker*}.  It will
+also start the asynchronous download of headlines.  The modeline in
+the @samp{*newsticker*} buffer informs whenever new headlines have
+arrived.  Clicking mouse-button 2 or pressing RET in this buffer on a
+headline will call @code{browse-url} to load the corresponding news
+story in your favourite web browser.
+
address@hidden newsticker-start-ticker
address@hidden 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
+stopped with @code{newsticker-stop-ticker}.
+
address@hidden newsticker-start
address@hidden newsticker-stop
+If you just want to start the periodic download of headlines use the
+command @code{newsticker-start}. Calling @code{newsticker-stop} will
+stop the periodic download, but will call
address@hidden as well.
+
address@hidden Configuration
address@hidden Configuration
+
+All Newsticker options are customizable, i.e. they can be changed with
+Emacs customization methods: Call the command
address@hidden and enter @samp{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.
+
+Newsticker options are organized in the following groups.
+
address@hidden
+
address@hidden
address@hidden contains options that define which news
+feeds are retrieved and how this is done.  
+
address@hidden
address@hidden
address@hidden newsticker-url-list
address@hidden defines the list of headlines which are
+retrieved.
address@hidden
address@hidden newsticker-retrieval-interval
address@hidden defines how often headlines
+are retrieved.
address@hidden itemize
+
address@hidden
address@hidden contains options that define
+how the retrieved headlines are processed.
+
address@hidden
address@hidden
address@hidden newsticker-keep-obsolete-items
address@hidden decides whether unread
+headlines that have been removed from the feed are kept in the
+Newsticker cache.
address@hidden itemize
+
address@hidden
address@hidden contains options that define how the
+buffer for reading news headlines is formatted.
+
address@hidden
address@hidden
address@hidden newsticker-heading-format
address@hidden defines how the title of a headline
+is formatted.
address@hidden itemize
+
address@hidden
address@hidden contains options that define how headlines
+are shown in the echo area.
+
address@hidden
address@hidden
address@hidden newsticker-display-interval
address@hidden newsticker-scroll-smoothly
address@hidden and
address@hidden define how headlines are shown in
+the echo area.
address@hidden itemize
+
address@hidden
address@hidden contains options for hooking other Emacs
+commands to newsticker functions. 
address@hidden
address@hidden
address@hidden newsticker-new-item-functions
address@hidden allows for automatic
+processing of headlines. See `newsticker-download-images', and
+`newsticker-download-enclosures' for sample functions.
address@hidden itemize
+
address@hidden
address@hidden contains other Newsticker options.
+
address@hidden itemize
+
+Please have a look at the customization buffers for the complete list
+of options.
+
address@hidden Remarks
address@hidden Remarks
+
+This newsticker is designed do its job silently in the background
+without disturbing you.  However, it is probably impossible to prevent
+such a tool from slightly attenuating your Editor's responsiveness
+every once in a while.
+
+Byte-compiling newsticker.el is recommended.
+
address@hidden GNU Free Documentation License
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
address@hidden Index
address@hidden Index
+
address@hidden cp
+
address@hidden
+
+
+
address@hidden
+   arch-tag: 7a4de539-117c-4658-b799-0b9e3d0ccec0
address@hidden ignore