NEWSBEUTER(1)
===========
Andreas Krennmair <ak@newsbeuter.org>


NAME
----
newsbeuter - an RSS feed reader for text terminals


SYNOPSIS
--------
'newsbeuter' [-r] [-e] [-i opmlfile] [-u urlfile] [-c cachefile] [-C configfile] [-X] [-o] [-x <command> ...] [-h]


DESCRIPTION
-----------
'newsbeuter' is an RSS feed reader for text terminals. RSS is a number of
widely-used XML formats to transmit, publish and syndicate articles, for
example news or blog articles.  Newsbeuter is designed to be used on text
terminals on Unix or Unix-like systems such as Linux, BSD or Mac OS X.


OPTIONS
-------
-h::
        Display help

-r::
        Refresh feeds on start

-e::
        Export feeds as OPML to stdout

-X::
        Clean up cache thoroughly (i.e. reduce it in size if possible)

-v, -V::
        Get version information about newsbeuter and the libraries it uses

-i opmlfile::
       Import an OPML file

-u urlfile::
       Use an alternative URL file

-c cachefile::
       Use an alternative cache file

-C configfile::
       Use an alternative configuration file

-x command ...::
       Execute one or more commands to run newsbeuter unattended. Currently available
       commands are "reload" and "print-unread".

-o::
       Active offline reading mode. When Google Reader synchronization mode is configured,
       then the list of feeds will not be loaded from Google Reader, but instead from
       the local cache. This makes it possible to read locally cached articles even
       without internet connection to connect to Google Reader.

-l loglevel::
       Generate a loglevel with a certain loglevel. Valid loglevels are 1 to 6. An
       actual logfile will only be written when you provide a logfile name.

-d logfile::
       Use this logfile as output when logging debug messages. Please note that this
       only works when providing a loglevel.

-E file::
       Export a list of read articles (resp. their GUIDs). This can be used to
       transfer information about read articles between different computers.

-I file::
      Import a list of read articles and mark them as read if they are held in the
      cache. This is to be used in conjunction with the -E commandline parameter.

FIRST STEPS
-----------

include::chapter-firststeps.txt[]

CONFIGURATION COMMANDS
----------------------

include::newsbeuter-cfgcmds.txt[]


AVAILABLE OPERATIONS
----------------------

include::newsbeuter-keycmds.txt[]


TAGGING
-------

include::chapter-tagging.txt[]


SCRIPTS AND FILTERS
-------------------

include::chapter-snownews.txt[]


COMMAND LINE
------------

include::chapter-cmdline.txt[]

'quit'::
        Quit newsbeuter

'save' <filename>::
        Save current article to <filename>

'set' <variable>[=<value>|&|!]::
        Set (or get) configuration variable value. Specifying a '!' after the name of a boolean configuration variable toggles their values, a '&' directly after the name of a configuration variable of any type resets its value to the documented default value.

'tag' <tagname>::
        Select a certain tag

'goto' <case-insensitive substring>::
        Go to the next feed whose name contains the case-insensitive substring.

'source' <filename> [...]::
        Load the specified configuration files. This allows it to load alternative configuration files or reload already loaded configuration files on-the-fly from the filesystem.

'dumpconfig' <filename>::
       Save current internal state of configuration to file, so that it can be instantly reused as configuration file.

'<number>'::
        Jump to the <number>th entry in the current dialog


FILES
-----

'$HOME/.newsbeuter/config'

'$HOME/.newsbeuter/urls'


SEE ALSO
--------
podbeuter(1). The documentation that comes with newsbeuter is a good
source about the general use and configuration of newsbeuter.


AUTHORS
-------
Andreas Krennmair <ak@newsbeuter.org>, for contributors see AUTHORS file.


